Get all Tenants

{ getAllTenants }

Get a list of all tenants and their related metadata

Method

/API3/access/getAllTenants

  • API Section: /API3/access
  • API Version: 3.0
  • From Release: 2023.10
  • Can be used by all user types
  • REST API and Client SDK libraries. REST APIs via POST actions only.
  • Output Response

    Successful Result Code

    200

    Response List Type

    Description of Response Type

    Tenant response object with details of each tenant found in the system.. Note that the response is returned as a list of items of this object type.

    Code Snippets

    JavaScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
    -H "paToken: [[apiKey]]" \
     -H "Accept: application/json" \
     "http://Your.Server.URL/API3/access/getAllTenants"
    
    import com.pyramidanalytics.*;
    import com.pyramidanalytics.auth.*;
    import com.pyramidanalytics.model.*;
    import com.pyramidanalytics.api.AccessServiceApi;
    
    import java.util.*;
    
    public class AccessServiceApiExample {
        public static void main(String[] args) {
            ApiClient defaultClient = Configuration.getDefaultApiClient();
            defaultClient.setBasePath("http://Your.Server.URL/");
            
            // Configure API key authorization: paToken
            ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
            paToken.setApiKey("YOUR API KEY");
            // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
            //paToken.setApiKeyPrefix("Token");
    
            // Create an instance of the API class
            AccessServiceApi apiInstance = new AccessServiceApi();
    
            try {
                // "array[AdminMultiTenantData]" is only psaudo-code to symbolize list of type and not the actual usage 
                array[AdminMultiTenantData] result = apiInstance.getAllTenants();
                System.out.println(result);
            } catch (ApiException e) {
                System.err.println("Exception when calling AccessServiceApi#getAllTenants");
                e.printStackTrace();
            }
        }
    }
    
    const PyramidAnalyticsWebApi = require('pyramid_analytics_web_api');
    const defaultClient = PyramidAnalyticsWebApi.ApiClient.instance;
    
    // Configure API key authorization: paToken
    const paToken = defaultClient.authentications['paToken'];
    paToken.apiKey = "YOUR API KEY";
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //paToken.apiKeyPrefix['paToken'] = "Token";
    
    // Create an instance of the API class
    const api = new PyramidAnalyticsWebApi.AccessServiceApi("http://Your.Server.URL")
    const callback = function(error, data, response) {
      if (error) {
        console.error(error);
      } else {
        console.log('API called successfully. Returned data: ' + data);
      }
    };
    api.getAllTenants(callback);
    
    using System;
    using System.Diagnostics;
    using PyramidAnalytics.Sdk.Api;
    using PyramidAnalytics.Sdk.Client;
    using PyramidAnalytics.Sdk.Model;
    
    public class getAllTenantsExample
    {
        public static void Main()
        {
            Configuration conf = new Configuration();
            conf.BasePath = "http://Your.Server.URL/";
            
            // Configure API key authorization: paToken
            conf.ApiKey.Add("paToken", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // conf.ApiKeyPrefix.Add("paToken", "Bearer");
    
            GlobalConfiguration.Instance = conf;
            
            // Create an instance of the API class
            var apiInstance = new AccessServiceApi();
    
            try {
                // Get a list of all tenants and their related metadata
                // "array[AdminMultiTenantData]" is only psaudo-code to symbolize array of type and not the actual usage 
                array[AdminMultiTenantData] result = apiInstance.getAllTenants();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AccessServiceApi.getAllTenants: " + e.Message );
            }
        }
    }
    
    
    import com.pyramidanalytics
    from com.pyramidanalytics import ApiException
    from pprint import pprint
    
    
    # Configure API key authorization: paToken
    api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_config.api_key_prefix['paToken'] = 'Bearer'
    
    with com.pyramidanalytics.ApiClient(api_config) as api_client:
        # Create an instance of the API class
        api_instance = com.pyramidanalytics.AccessServiceApi(api_client)
    
        try:
            # Get a list of all tenants and their related metadata
            api_response = api_instance.get_all_tenants()
            pprint(api_response)
        except ApiException as e:
            print("Exception when calling AccessServiceApi->getAllTenants: %s\n" % e)
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
    
    // Configure API key authorization: paToken
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
    // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    // OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
    
    // Create an instance of the API class
    $api_instance = new OpenAPITools\Client\Api\AccessServiceApi();
    
    try {
        $result = $api_instance->getAllTenants();
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling AccessServiceApi->getAllTenants: ', $e->getMessage(), PHP_EOL;
    }
    ?>

    Note: Use the 'Authentication' API methods to generate an access 'key' or 'token'.